/*
 * OREKIT-X
 * Copyright 2002-2008 CS Communication & Systemes
 * 
 * Parts of this software package have been licensed to CS
 * Communication & Systemes (CS) under one or more contributor license
 * agreements.  See the NOTICE file distributed with this work for
 * additional information.
 *  
 * This is an experimental copy of OREKIT from www.orekit.org.
 * Please use the original OREKIT from orekit.org for normal work
 * unrelated to this research project.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License.  You
 * may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied.  See the License for the specific language governing
 * permissions and limitations under the License.
 */
package ore.forces.gravity.potential;

import ore.errors.OrekitException;

/**
 * Interface used to provide gravity potential coefficients.
 * 
 * @see PotentialReaderFactory
 * 
 * @author Luc Maisonobe
 */
public interface PotentialCoefficientsProvider {

    /** 
     * Central body attraction coefficient.
     * @return mu (m<sup>3</sup>/s<sup>2</sup>)
     */
    public double getMu();

    /** 
     * Central body reference radius.
     * @return ae (m)
     */
    public double getAe();

    /** 
     * @param normalized (true) or un-normalized (false)
     * @param n the maximal degree requested
     * 
     * @return J the zonal coefficients array.
     * 
     * @exception OrekitException if the requested maximal degree exceeds the
     * available degree
     */
    public double[] getJ(boolean normalized, int n)
        throws OrekitException;

    /** 
     * Tesseral-sectorial and zonal coefficients.
     * @param n the degree
     * @param m the order
     * @param normalized (true) or un-normalized (false)
     * 
     * @return the cosines coefficients matrix
     * 
     * @exception OrekitException if the requested maximal degree or order exceeds the
     * available degree or order
     */
    public double[][] getC(int n, int m, boolean normalized)
        throws OrekitException;

    /** 
     * Tesseral-sectorial coefficients.
     * @param n the degree
     * @param m the order
     * @param normalized (true) or un-normalized (false)
     * 
     * @return the sines coefficients matrix
     * 
     * @exception OrekitException if the requested maximal degree or order exceeds the
     * available degree or order
     */
    public double[][] getS(int n, int m, boolean normalized)
        throws OrekitException;
}
